home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / batchut / choice17.zip / CHOICE.DOC < prev    next >
Text File  |  1990-03-10  |  15KB  |  399 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.                                   C H O I C E
  15.  
  16.                                       by
  17.                                Michael L. Wilson
  18.  
  19.                                   version 1.7
  20.                                 March 10, 1990
  21.  
  22.  
  23.                                Copyright (c) 1990
  24.                            Compufax Computer Systems
  25.                                 1840 41st Avenue
  26.                                  Suite 102-124
  27.                               Capitola, CA  95010
  28.                                  408-479-7702
  29.  
  30.  
  31. CHOICE                                                                  page i
  32.  
  33.  
  34.                         T A B L E   O F   C O N T E N T S
  35.  
  36.  
  37.                I.  Introduction..................................1
  38.  
  39.               II.  Usage.........................................1
  40.  
  41.              III.  Revision Hostory..............................x
  42.  
  43.               IV.  Acknowledgements..............................x
  44.  
  45.                V.  License, Limits, Disclaimer...................x
  46.  
  47.  
  48.  
  49. CHOICE                                                                  page 1
  50.  
  51.  
  52.      INTRODUCTION:
  53.  
  54.        What is Choice?
  55.        Choice is a program that allows users to answer questions in batch
  56.        files.  Unlike the other "ASK" type programs in the market, CHOICE
  57.        has many more features:
  58.  
  59.                 Use any prompt you desire
  60.                 Only accept desired letters for input
  61.                 Display a file above the prompt (for menus)
  62.                 On-line help
  63.                 User definable color
  64.                 Place the prompt ANYWHERE  on the screen
  65.                 Timeouts
  66.                 Default choice when return or spacebar is pressed
  67.                 Shows, if desired, the acepted letters, default choice
  68.                   and timeout.
  69.                 Set Type-Ahead buffer
  70.                 Set the system errorlevel to the position of the pressed
  71.                   key in the list.
  72.  
  73.      
  74.      
  75.      USAGE:
  76.  
  77.        The Syntax for CHOICE is:
  78.  
  79.            CHOICE prompt letters [options]
  80.  
  81.        The prompt can be any character string.  If there are embedded spaces,
  82.        the prompt must be enclosed in quotes.
  83.        EXAMPLE:     "Enter your Choice >>"
  84.  
  85.        Letters is a list of the letters that are acceptable.  If the list has
  86.        embedded spaces, it must be enclosed in quotes.
  87.        EXAMPLE:     ABCDEFG
  88.  
  89.        The acceptable options are:
  90.  
  91.            FILE=filename
  92.            COLOR=fore,back
  93.            WHERE=row,col
  94.            TIMEOUT=seconds
  95.            DEFAULT=letter
  96.            KEYS=length of buffer
  97.            SHOW
  98.  
  99.        When the user presses a key, and it is part of the list, then the
  100.        system errorlevel is set to the position of that letter in the list.
  101.        EXAMPLE:  If the list was ABCD and the user pressed C then the system
  102.                  errorlevel would be set to 3.
  103.  
  104.  
  105.  
  106. CHOICE                                                                  page 2
  107.  
  108.        The Options Explained:
  109.  
  110.           FILE:   The FILE= option must immediatly be followed by a legal
  111.                   DOS filename, with no spaces.  This file will be displayed
  112.                   on the screen before the prompt.  If the file is longer
  113.                   than your screen length, your screen will scroll.  The
  114.                   file is displayed in the color specified by the COLOR=
  115.                   option.
  116.                   EXAMPLE:   FILE=menu.dat
  117.  
  118.           COLOR:  The COLOR= option will determin ethe color of the prompt
  119.                   and the displayed file.  The foreground and background
  120.                   colors must immediatly follow the equal sign, with no
  121.                   spaces.  These numbers are separated by a comma.  The
  122.                   colors are represented by numbers.  The foreground must
  123.                   be a number between 0 and 15.  The background must be a
  124.                   number between 0 and 15.  The background numbers 0-7 are
  125.                   the normal background colors.  The background numbers
  126.                   8-15 are a repeat of the 0-7 list but cause the current
  127.                   forground color to blink.   See Appendix A for a list
  128.                   of these numbers and colors.
  129.                   EXAMPLE:    COLOR=12,5
  130.                   
  131.  
  132.           WHERE:  The WHERE= option determines where the prompt will be
  133.                   located on the screen.  The row and column number must
  134.                   immediatly follow the equal sign with no spaces.  The
  135.                   row and column number are separated by a comma.
  136.                   EXAMPLE:    WHERE=5,15
  137.  
  138.           TIMEOUT:The TIMEOUT= option determines the number of seconds
  139.                   before the prompt times out and the default is chosen.
  140.                   The number of seconds must come immediatly after the
  141.                   equal sign with no spaces.
  142.                   EXAMPLE:    TIMEOUT=30
  143.  
  144.           DEFAULT:The DEFAULT= option determines which letter is automatically
  145.                   chosen when the prompt times out, the spacebar is ressed,
  146.                   or the Return key is pressed.  The single letter default
  147.                   must immediatly follow the equal sign.  It must also be
  148.                   part of the letters list.
  149.                   EXAMPLE:    DEFAULT=A
  150.  
  151.           KEYS:   The KEYS= options sets the length of the type ahead buffer.
  152.                   The number of type ahead keys must come immediatly after
  153.                   the equal sign.  If the number is greater than the current
  154.                   type ahead buffer, then KEYS is set to the current buffer's
  155.                   size.
  156.                   EXAMPLE:    KEYS=3    
  157.  
  158.           SHOW:   The SHOW options has no parameters.  If used, it will 
  159.                   display the acceptable keys, the timeout (if any) and
  160.                   the default key (if any).
  161.                   EXAMPLE:    SHOW      
  162.  
  163.  
  164. CHOICE                                                                  page 3
  165.  
  166.  
  167.      REVISION HISTORY
  168.  
  169.          version 1.6   1-24-90
  170.             First Shareware release
  171.  
  172.          version 1.7   3-10-90
  173.             Demo batch file included in archive
  174.             Fixed a random error due to reading way past command line
  175.  
  176.  
  177.  
  178.  
  179. CHOICE                                                                  page 4
  180.  
  181.                                    LICENSE
  182.  
  183.  
  184.  
  185.       This version of CHOICE is NOT public domain nor free software, but
  186.       is being distributed as "shareware".
  187.  
  188.       CHOICE is copyright (C) 1990 by Compufax Computer Systems.
  189.  
  190.       Non-registered users of this software are granted a limited
  191.       license to make an evaluation copy for trial use on a private,
  192.       non-commercial basis, for the express purpose of determining
  193.       whether CHOICE is suitable for their needs.  At the end of this
  194.       trial period, you should either register your copy or
  195.       discontinue using CHOICE.
  196.  
  197.       What does all this really mean?  If you use this program, then
  198.       you should pay for your copy.  That way we'll be able to provide
  199.       you support, updates and stay in business.
  200.  
  201.       A CHOICE registration entitles you to use the program on any and
  202.       all computers available to you, with the following restriction:
  203.       If other people have access to this program or may use it, then
  204.       you should purchase a site license.  See the following section
  205.       for information about site licensing or quantity discounts.
  206.  
  207.       All users are granted a limited license to copy CHOICE only for
  208.       the trial use of others and subject to the above limitations.
  209.       This license does NOT include distribution or copying of this
  210.       software package:
  211.  
  212.         1. In connection with any other product or service.
  213.         2. For general use within a company or institution.
  214.         3. For any consideration or 'disk fee'.
  215.         4. Distribution in modified form, i.e., the file containing
  216.            this license information MUST be included, along with the
  217.